

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>pysimm.utils module &mdash; pysimm 0.2 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="pysimm 0.2 documentation" href="index.html"/>
        <link rel="up" title="pysimm package" href="pysimm.html"/>
        <link rel="prev" title="pysimm.system module" href="pysimm.system.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> pysimm
          

          
          </a>

          
            
            
              <div class="version">
                0.2
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="pysimm.html">pysimm package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="pysimm.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="pysimm.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="pysimm.amber.html">pysimm.amber module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pysimm.calc.html">pysimm.calc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pysimm.cassandra.html">pysimm.cassandra module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pysimm.cli.html">pysimm.cli module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pysimm.lmps.html">pysimm.lmps module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pysimm.system.html">pysimm.system module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="">pysimm.utils module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pysimm.html#module-pysimm">Module contents</a></li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">pysimm</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          

 



<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
          <li><a href="pysimm.html">pysimm package</a> &raquo;</li>
      
    <li>pysimm.utils module</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/pysimm.utils.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="module-pysimm.utils">
<span id="pysimm-utils-module"></span><h1>pysimm.utils module<a class="headerlink" href="#module-pysimm.utils" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="pysimm.utils.Container">
<em class="property">class </em><code class="descclassname">pysimm.utils.</code><code class="descname">Container</code><a class="reference internal" href="_modules/pysimm/utils.html#Container"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.Container" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Abitrary container object that returns None if trying to access an attribute that does not exist</p>
</dd></dl>

<dl class="class">
<dt id="pysimm.utils.Item">
<em class="property">class </em><code class="descclassname">pysimm.utils.</code><code class="descname">Item</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#Item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.Item" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="pysimm.utils.Item.copy">
<code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#Item.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.Item.copy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pysimm.utils.Item.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#Item.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.Item.set" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="pysimm.utils.ItemContainer">
<em class="property">class </em><code class="descclassname">pysimm.utils.</code><code class="descname">ItemContainer</code><span class="sig-paren">(</span><em>_dict=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#ItemContainer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.ItemContainer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">_abcoll.Sequence</span></code></p>
<p>Container object intended to organize <a class="reference internal" href="#pysimm.utils.Item" title="pysimm.utils.Item"><code class="xref py py-class docutils literal"><span class="pre">Item</span></code></a> objects. Arbitrary attributes can be set using keyword arguments. Underlying data structure is a dictionary where the key is referred to as a tag, and the value should be an <a class="reference internal" href="#pysimm.utils.Item" title="pysimm.utils.Item"><code class="xref py py-class docutils literal"><span class="pre">Item</span></code></a> object. <a class="reference internal" href="#pysimm.utils.Item" title="pysimm.utils.Item"><code class="xref py py-class docutils literal"><span class="pre">Item</span></code></a>.tag should equal the key for the object in the dictionary.</p>
<dl class="method">
<dt id="pysimm.utils.ItemContainer.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>_item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#ItemContainer.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.ItemContainer.add" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pysimm.utils.ItemContainer.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#ItemContainer.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.ItemContainer.get" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pysimm.utils.ItemContainer.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>index</em>, <em>update=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#ItemContainer.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.ItemContainer.remove" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="exception">
<dt id="pysimm.utils.PysimmError">
<em class="property">exception </em><code class="descclassname">pysimm.utils.</code><code class="descname">PysimmError</code><a class="reference internal" href="_modules/pysimm/utils.html#PysimmError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.PysimmError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
</dd></dl>

<dl class="function">
<dt id="pysimm.utils.compare">
<code class="descclassname">pysimm.utils.</code><code class="descname">compare</code><span class="sig-paren">(</span><em>query</em>, <em>item</em>, <em>query_wildcard=None</em>, <em>item_wildcard='X'</em>, <em>order=False</em>, <em>improper_type=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pysimm/utils.html#compare"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysimm.utils.compare" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
      
        <a href="pysimm.system.html" class="btn btn-neutral" title="pysimm.system module" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2017, https://pysimm.org.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'0.2',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>